Add Debugging Instructions to Devcontainer Setup in CONTRIBUTING.md #7673
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7673 +/- ##
==========================================
- Coverage 89.69% 89.69% -0.01%
==========================================
Files 283 283
Lines 60510 60509 -1
Branches 7541 7541
==========================================
- Hits 54277 54276 -1
Misses 4077 4077
Partials 2156 2156 |
m3hm3t
force-pushed
the
users/m3hm3t/devcontainer_debug
branch
from
120a686 to
150c515
Compare
CONTRIBUTING.md
Outdated
| ``` | ||
| postgres: citus citus [local] idle | ||
| ``` |
There was a problem hiding this comment.
Although this works great when having a single psql session open, it fails when multiple sessions open, or when you are connecting over the tcp stack instead of the named pipe.
Not saying to remove this, as it could cover a good portion of the simple workflows.
However, it would be great to add a section on the pid of the backend you are connected to. When running in the devcontainer a .psqlrc is installed in the devcontainer which changes the prompt of psql to show the pid of the running process.
citus@07de2e6180a9:/data$ psql
Timing is on.
Line style is unicode.
Border style is 2.
psql (16.2)
Type "help" for help.
[local] citus@citus:9700-3783=# The last number in the prompt, 3783 is the pid of the backend that psql session is connected to.
If you have the process selector open for the debugger you can simply type these numbers, which is generally easier than typing the name of the process - although a tactical [local] will filter it down to the sessions connected via the named pipe.
There was a problem hiding this comment.
Thanks for the feedback! @thanodnl
You're right, this method works well for simple workflows with a single psql session but can be tricky when dealing with multiple sessions or TCP connections. I added a section to clarify how to locate the pid of the backend you're connected to in the container setup. The .psqlrc prompt tweak showing the pid is a great tip—I included it.
…itusdata#7673) **Description:** This PR adds a section to CONTRIBUTING.md that explains how to set up debugging in the devcontainer using VS Code. **Changes:** - **New Debugging Section**: Clear instructions on starting the debugger, selecting the appropriate PostgreSQL process, and setting breakpoints for easier troubleshooting. **Purpose:** - **Improved Contributor Workflow**: Enables contributors to debug the Citus extension within the devcontainer, enhancing productivity and making it easier to resolve issues. --------- Co-authored-by: Mehmet YILMAZ <[email protected]>
Description:
This PR adds a section to CONTRIBUTING.md that explains how to set up debugging in the devcontainer using VS Code.
Changes:
Purpose: